<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
FsIndexFactory (uimaFIT 1.3.1 API)
</TITLE>


<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="FsIndexFactory (uimaFIT 1.3.1 API)";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FsIndexFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/uimafit/factory/FlowControllerFactory.html" title="class in org.uimafit.factory"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/uimafit/factory/JCasBuilder.html" title="class in org.uimafit.factory"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/uimafit/factory/FsIndexFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="FsIndexFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.uimafit.factory</FONT>
<BR>
Class FsIndexFactory</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.uimafit.factory.FsIndexFactory</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.50"><B>FsIndexFactory</B></A><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>

<P>
<DL>
<DT><B>Author:</B></DT>
  <DD>Richard Eckart de Castilho</DD>
</DL>
<HR>

<P>
<!-- =========== FIELD SUMMARY =========== -->

<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#FS_INDEX_IMPORT_PATTERN">FS_INDEX_IMPORT_PATTERN</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;System property indicating which locations to scan for index descriptions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#FS_INDEX_MANIFEST_PATTERN">FS_INDEX_MANIFEST_PATTERN</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Index manifest location.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#REVERSE_STANDARD_COMPARE">REVERSE_STANDARD_COMPARE</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#STANDARD_COMPARE">STANDARD_COMPARE</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#FsIndexFactory()">FsIndexFactory</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#createFsIndexCollection()">createFsIndexCollection</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><CODE>FsIndexCollection</CODE></A> from all index descriptions that can be found via the
 <A HREF="../../../org/uimafit/factory/FsIndexFactory.html#FS_INDEX_IMPORT_PATTERN"><CODE>FS_INDEX_IMPORT_PATTERN</CODE></A> or via the <code>META-INF/org.uimafit/fsindexes.txt</code> files
 in the classpath.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#createFsIndexCollection(java.lang.Class)">createFsIndexCollection</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;?&gt;&nbsp;componentClass)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create index configuration data for a given class definition using reflection and the
 configuration parameter annotation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#createFsIndexCollection(org.apache.uima.resource.metadata.FsIndexDescription...)">createFsIndexCollection</A></B>(<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexDescription</A>...&nbsp;descriptions)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#createFsIndexCollection(java.lang.String...)">createFsIndexCollection</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>...&nbsp;descriptorNames)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><CODE>FsIndexCollection</CODE></A> from descriptor names.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexDescription</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#createFsIndexDescription(java.lang.String, java.lang.String, java.lang.String, boolean, org.apache.uima.resource.metadata.FsIndexKeyDescription...)">createFsIndexDescription</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;label,
                                                 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;kind,
                                                 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;typeName,
                                                 boolean&nbsp;useTypePriorities,
                                                 <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexKeyDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexKeyDescription</A>...&nbsp;keys)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexKeyDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexKeyDescription</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#createFsIndexKeyDescription(java.lang.String)">createFsIndexKeyDescription</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;featureName)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexKeyDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexKeyDescription</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#createFsIndexKeyDescription(java.lang.String, int)">createFsIndexKeyDescription</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;featureName,
                                                       int&nbsp;comparator)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#createTypeSystemDescriptionFromPath(java.lang.String...)">createTypeSystemDescriptionFromPath</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>...&nbsp;descriptorURIs)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><CODE>FsIndexCollection</CODE></A> from a descriptor file</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#forceIndexDescriptorsScan()">forceIndexDescriptorsScan</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Force rescan of type descriptors.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/uimafit/factory/FsIndexFactory.html#scanIndexDescriptors()">scanIndexDescriptors</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get all currently accessible index descriptor locations.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="STANDARD_COMPARE"><!-- --></A><H3>
STANDARD_COMPARE</H3>
<PRE>
public static final int <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.51"><B>STANDARD_COMPARE</B></A></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.uimafit.factory.FsIndexFactory.STANDARD_COMPARE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="REVERSE_STANDARD_COMPARE"><!-- --></A><H3>
REVERSE_STANDARD_COMPARE</H3>
<PRE>
public static final int <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.53"><B>REVERSE_STANDARD_COMPARE</B></A></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.uimafit.factory.FsIndexFactory.REVERSE_STANDARD_COMPARE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="FS_INDEX_IMPORT_PATTERN"><!-- --></A><H3>
FS_INDEX_IMPORT_PATTERN</H3>
<PRE>
public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.155"><B>FS_INDEX_IMPORT_PATTERN</B></A></PRE>
<DL>
<DD>System property indicating which locations to scan for index descriptions. A list of
 locations may be given separated by ";".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.uimafit.factory.FsIndexFactory.FS_INDEX_IMPORT_PATTERN">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="FS_INDEX_MANIFEST_PATTERN"><!-- --></A><H3>
FS_INDEX_MANIFEST_PATTERN</H3>
<PRE>
public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.160"><B>FS_INDEX_MANIFEST_PATTERN</B></A></PRE>
<DL>
<DD>Index manifest location.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.uimafit.factory.FsIndexFactory.FS_INDEX_MANIFEST_PATTERN">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="FsIndexFactory()"><!-- --></A><H3>
FsIndexFactory</H3>
<PRE>
public <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.50"><B>FsIndexFactory</B></A>()</PRE>
<DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="createFsIndexCollection(java.lang.Class)"><!-- --></A><H3>
createFsIndexCollection</H3>
<PRE>
public static <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.59"><B>createFsIndexCollection</B></A>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;?&gt;&nbsp;componentClass)</PRE>
<DL>
<DD>Create index configuration data for a given class definition using reflection and the
 configuration parameter annotation.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createFsIndexDescription(java.lang.String, java.lang.String, java.lang.String, boolean, org.apache.uima.resource.metadata.FsIndexKeyDescription...)"><!-- --></A><H3>
createFsIndexDescription</H3>
<PRE>
public static <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexDescription</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.122"><B>createFsIndexDescription</B></A>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;label,
                                                          <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;kind,
                                                          <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;typeName,
                                                          boolean&nbsp;useTypePriorities,
                                                          <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexKeyDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexKeyDescription</A>...&nbsp;keys)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createFsIndexCollection(org.apache.uima.resource.metadata.FsIndexDescription...)"><!-- --></A><H3>
createFsIndexCollection</H3>
<PRE>
public static <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.132"><B>createFsIndexCollection</B></A>(<A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexDescription</A>...&nbsp;descriptions)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createFsIndexKeyDescription(java.lang.String)"><!-- --></A><H3>
createFsIndexKeyDescription</H3>
<PRE>
public static <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexKeyDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexKeyDescription</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.138"><B>createFsIndexKeyDescription</B></A>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;featureName)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createFsIndexKeyDescription(java.lang.String, int)"><!-- --></A><H3>
createFsIndexKeyDescription</H3>
<PRE>
public static <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexKeyDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexKeyDescription</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.142"><B>createFsIndexKeyDescription</B></A>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;featureName,
                                                                int&nbsp;comparator)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createFsIndexCollection(java.lang.String...)"><!-- --></A><H3>
createFsIndexCollection</H3>
<PRE>
public static <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.171"><B>createFsIndexCollection</B></A>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>...&nbsp;descriptorNames)</PRE>
<DL>
<DD>Creates a <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><CODE>FsIndexCollection</CODE></A> from descriptor names.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>descriptorNames</CODE> - The fully qualified, Java-style, dotted descriptor names.
<DT><B>Returns:</B><DD>a <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><CODE>FsIndexCollection</CODE></A> that includes the indexes from all of the specified files.</DL>
</DD>
</DL>
<HR>

<A NAME="createTypeSystemDescriptionFromPath(java.lang.String...)"><!-- --></A><H3>
createTypeSystemDescriptionFromPath</H3>
<PRE>
public static <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.192"><B>createTypeSystemDescriptionFromPath</B></A>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>...&nbsp;descriptorURIs)</PRE>
<DL>
<DD>Creates a <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><CODE>FsIndexCollection</CODE></A> from a descriptor file
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>descriptorURIs</CODE> - The descriptor file paths.
<DT><B>Returns:</B><DD>A <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><CODE>FsIndexCollection</CODE></A> that includes the indexes from all of the specified files.</DL>
</DD>
</DL>
<HR>

<A NAME="createFsIndexCollection()"><!-- --></A><H3>
createFsIndexCollection</H3>
<PRE>
public static <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata">FsIndexCollection</A> <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.215"><B>createFsIndexCollection</B></A>()
                                                 throws <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true" title="class or interface in org.apache.uima.resource">ResourceInitializationException</A></PRE>
<DL>
<DD>Creates a <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/metadata/FsIndexCollection.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><CODE>FsIndexCollection</CODE></A> from all index descriptions that can be found via the
 <A HREF="../../../org/uimafit/factory/FsIndexFactory.html#FS_INDEX_IMPORT_PATTERN"><CODE>FS_INDEX_IMPORT_PATTERN</CODE></A> or via the <code>META-INF/org.uimafit/fsindexes.txt</code> files
 in the classpath.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the auto-scanned indexes.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true" title="class or interface in org.apache.uima.resource">ResourceInitializationException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="scanIndexDescriptors()"><!-- --></A><H3>
scanIndexDescriptors</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.249"><B>scanIndexDescriptors</B></A>()
                                     throws <A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true" title="class or interface in org.apache.uima.resource">ResourceInitializationException</A></PRE>
<DL>
<DD>Get all currently accessible index descriptor locations. A scan is actually only
 performed on the first call and the locations are cached. To force a re-scan use
 <A HREF="../../../org/uimafit/factory/FsIndexFactory.html#forceIndexDescriptorsScan()"><CODE>forceIndexDescriptorsScan()</CODE></A>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an array of locations.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://uima.apache.org/d/uimaj-2.4.0/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true" title="class or interface in org.apache.uima.resource">ResourceInitializationException</A></CODE> - if the locations could not be resolved.</DL>
</DD>
</DL>
<HR>

<A NAME="forceIndexDescriptorsScan()"><!-- --></A><H3>
forceIndexDescriptorsScan</H3>
<PRE>
public static void <A HREF="../../../src-html/org/uimafit/factory/FsIndexFactory.html#line.261"><B>forceIndexDescriptorsScan</B></A>()</PRE>
<DL>
<DD>Force rescan of type descriptors. The next call to <A HREF="../../../org/uimafit/factory/FsIndexFactory.html#scanIndexDescriptors()"><CODE>scanIndexDescriptors()</CODE></A> will rescan
 all auto-import locations.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FsIndexFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/uimafit/factory/FlowControllerFactory.html" title="class in org.uimafit.factory"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/uimafit/factory/JCasBuilder.html" title="class in org.uimafit.factory"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/uimafit/factory/FsIndexFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="FsIndexFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &#169; 2012. All Rights Reserved.
</BODY>
</HTML>
